Skip to content
This repository was archived by the owner on Dec 6, 2025. It is now read-only.

Conversation

@Jake-Pullen
Copy link
Owner

Description:

  • Summary: Using mdbook (Rust) to build and add a documentation web interface.
  • Motivation: Documentation was something we needed to properly formalise, this method follows one of the Verity constraints of Rust First Tooling.
  • Proposed Solution: Using Markdown provides an easy and widely used way to add documentation, mdbooks takes that markdown documentation and converts it into a easy to navigate "book" of documentation in your web browser.
  • Testing: No tests needed for actual documentation, building and running the documentation book was manually tested.
  • Known Limitations/Future Considerations: Requires rust and mdbook to be installed
    3. Checklist:

[ x ] I have followed the project's coding style and conventions.
[ x ] My code has been tested locally.
[ x ] I have updated the documentation (if necessary).
[ x ] I have labeled this PR appropriately (e.g., "bug," "feature," "refactor").

@Jake-Pullen Jake-Pullen merged commit 660fda9 into stage Jul 17, 2025
1 check passed
@Jake-Pullen Jake-Pullen deleted the better_docs branch July 17, 2025 13:42
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants